home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 401-425 / disk_420 / menuwriter / menuwriter3.1.doc < prev    next >
Text File  |  1992-05-06  |  9KB  |  237 lines
  1.                         MenuWriter 3.1 User Manual
  2.  
  3.                             December 12th, 1990
  4.  
  5.                         Requires the arp.library
  6.  
  7. DISCLAIMER
  8.  
  9. MenuWriter has been thoroughly tested and is the result of a constant
  10. process of changes and updates.  The program has proven to be stable in
  11. everyday use.  The author is not responsible for any loss of data, damages
  12. to software or hardware that may result directly or indirectly from the use
  13. of this program.
  14.  
  15.  
  16. This documentation will always be updated at the top.  Users of previous
  17. versions of MenuWriter need only to read the paragraph reflecting the
  18. changes since their last version.
  19.  
  20. Changes in version 3.1
  21. ----------------------
  22.  
  23. - General code cleanup and major rewriting of support routines
  24. - Improved startup routine
  25. - Squashed some 'potential' bugs.
  26. - NTSC version doesn't load PAL menus anymore and vice versa.
  27. - Fixed a bug in the startup code. BootX now uses the same current
  28.   directory as the CLI it was started from.
  29. - Added the 'Are you sure' requesters for the Quit and New menuitems.
  30. - Changed the menuitem 'Switch to' to 'Change sides'. Now you only have to
  31.   use this menuitem or Right-Amiga-C to change sides.
  32.  
  33.  
  34. Short introduction
  35. ------------------
  36.  
  37. MenuWriter 3.1 allows you to write a menu to the bootblock of a disk.  You
  38. have probably seen it on some public domain disk.  So what is so special
  39. about MenuWriter 3.1 ?  It allows for 40 entries (30 NTSC Amigas) of 39
  40. characters long.  The command to be issued can also be 31 characters long.
  41. On top of this the loader allows batch files to be executed.  More about
  42. this later.  All text in the menu and the loader is coded so the text can't
  43. be changed by the first person who loads it in a diskmonitor.  All this
  44. comes at an expense.  MenuWriter 3.1 uses 6 extra blocks on the disk to
  45. store the Menu program and data.
  46.  
  47. MenuWriter 3.1 now comes with a virus detector built-in.
  48.  
  49. There are two versions available:  one for European PAL Amigas and one for
  50. US NTSC Amigas.  The only difference is that the PAL version allows 40 and
  51. the NTSC version 30 menuitems.
  52.  
  53. MenuWriter 3.1 is fast and compact (it is written completely in assembler)
  54. and tries to be as user friendly as possible (use of the arp.library).
  55.  
  56. This program is shareware.  This program can be copied by anyone except for
  57. commercial use as long as this documentation file and the program icon
  58. accompanies the program.  Note that this program requires the Arp library
  59. to run.  So if you use this program and like it, please send a small
  60. contribution ($10 US would be nice) to:
  61.  
  62.         Peter Stuer
  63.         Kauwlei 21
  64.         B-2550 Kontich
  65.         Belgium - Europe
  66.  
  67. If you want the source code for the program, send me a disk.  Letters with
  68. comments or remarks are also welcome and will be answered as soon as
  69. possible.
  70.  
  71.                                                             Peter Stuer
  72.  
  73.  
  74. How to start MenuWriter 3.1
  75. ---------------------------
  76.  
  77. MenuWriter 3.1 (from here on referred to MenuWriter) can be started both
  78. from CLI and the Workbench.
  79.  
  80. Starting MenuWriter from the CLI
  81.  
  82. To start MenuWriter from the CLI simply type:
  83.  
  84.         1> MenuWriter3.1PAL     (for the PAL version)
  85.         1> MenuWriter3.1NTSC    (for the NTSC version)
  86.  
  87. followed by a return.  This loads the MenuWriter program and starts it.
  88. MenuWriter then detaches itself from the CLI.  This means that you can
  89. start MenuWriter, bring the Workbench screen back to the front and then
  90. close the CLI window with the EndCLI command.
  91.  
  92. Starting MenuWriter from the WorkBench
  93.  
  94. This is the easy part.  Simply click on the accompanying icon and
  95. MenuWriter starts.
  96.  
  97.  
  98.  
  99. How to use MenuWriter
  100. ---------------------
  101.  
  102. MenuWriter opens a new hires screen.  In the title bar you can see the name
  103. and the version of the program.  Next to the version is the indication
  104. "Side 1".  More about this later.
  105.  
  106. The program starts by showing you some information in a requester box.
  107. Simply click anywhere on the screen to continue.
  108.  
  109. The screen is divided in 4 parts:
  110.  
  111. 1. The screen title bar
  112. 2. A status line which will show relevant information to the user
  113. 3. 2 long boxes
  114. 4. 2 rows of 40 or 30 boxes
  115.  
  116. In the top 2 boxes you enter the title and subtitle of the menu.  Any text
  117. you enter will be centered automatically.
  118.  
  119. The other boxes represent one side of the menu:
  120.  
  121. The left side is the text that will appear in the menu, the right side is
  122. the name of the program (including arguments) that will be executed when
  123. the corresponding menuitem is selected.
  124.  
  125. This is where the 'Side' indicator comes in.  In the screen title
  126. MenuWriter shows you which side of the menu you are editing.
  127.  
  128. Pressing the right mousebutton shows you the menu bar.  There are 2 menus.
  129.  
  130. The first one, Project, allows you to load and save menus for later
  131. editing.
  132.  
  133. * About: shows you some information about the program
  134.  
  135. * New:  clears the current menu in memory.  NOTE:  no questions are asked.
  136. (Maybe in a next version)
  137.  
  138. * Load:  brings up the Arp filerequester for you to select a menu file for
  139. loading.  MenuWriter3.1 accepts only files created with this version of the
  140. program.
  141.  
  142. * Save:  brings up the Arp filerequester for you to select a menu file for
  143. saving.
  144.  
  145. * Quit: exits MenuWriter.
  146.  
  147.  
  148.  
  149. The 'Edit' menu.
  150.  
  151. * Switch to side: allows you to switch menu sides.
  152.  
  153. * Preview: shows you how the menu will look at boot time.
  154.  
  155. * Write menu to DFx:
  156.  
  157. This is the big one.  MenuWriter asks you to put a newly formatted disk in
  158. the drive you specified.  It is VERY IMPORTANT that the disk is newly
  159. formatted because it is possible that DOS has used block 2 thru 8 for
  160. files.  The menu will install without a problem but when you boot and make
  161. a selection in the menu, DOS will report a corrupt disk structure and the
  162. Amiga will crash.  There is one exception:  you can install the menu on a
  163. disk that has the menu on it already.  This is because all information will
  164. just be over written.  Use this feature to update an old menu.  MenuWriter
  165. allocates block 2 thru 9 in the bitmap pages, so afterwards you can use
  166. this disk like any DOS disk except that there will be 3072 bytes less then
  167. 880K free to use.  MenuWriter first creates a subdirectory C and puts the
  168. Loader and a WorkBench Run command in it.  The Run command is needed
  169. because the Amiga needs it to launch a child program.
  170. Then, if you answer Yes at the prompt, MenuWriter creates an S directory
  171. and writes a small startup-sequence to it.  BEWARE:  if you re-install a
  172. menu and have already modified the startup-sequence, you should answer NO
  173. to the prompt.  No backup is made of the old startup-sequence!
  174.  
  175. Also don't use a disk optimizer like B.A.D.  for instance because they
  176. rearrange the diskstructure so that the menu program might be overwritten.
  177.  
  178. It is possible that some viruskillers don't recognize the bootblock or in
  179. the worst case identify the bootblock as a virus.
  180.  
  181. About the virus detector
  182. ------------------------
  183.  
  184. The virus detector is simply a recent version of my Anti-Virus bootblock.
  185. Instead of trying to recognize any virusses, it checks some important
  186. vectors that are most likely to be changed by virusses.  If it finds
  187. something it doesn't like, it will display the names of the vector together
  188. with a suitable comment.  You then get the chance to either continue the
  189. boot proces, which in this case brings you to the menu, or reset the Amiga.
  190. The reset option also erares any code found at the suspicious addresses.
  191. This is the only way the erase a virus completely from memory.  Also since
  192. no virus signature is looked for, the bootblock will recognize any new
  193. bootblock or LINK VIRUSSES that come along.  (How's that for a bonus ?)
  194. Reset is done in a legal way.  (Found the specs on some Commodore disk).
  195. NOTE:  this bootblock is a DETECTOR, not a KILLER.  I do not guarentee that
  196. my method is fool-proof but it has worked so far.
  197.  
  198. About the commands
  199. ------------------
  200.  
  201.         The commands you enter on the right side can be anything from a
  202. command to a programname or even a batch file.
  203. Some examples:
  204.  
  205.         Menu text                       Command
  206.         ---------                       -------
  207.  
  208.         Show directory of DF0:          dir DF0:
  209.  
  210.         Deluxe Domino v17.8             DeluxeDomino17.8
  211.  
  212.         My font editor                  execute SYS:StartMyFontEditor
  213.  
  214. where 'StartMyFontEditor' is a batch file containing f.i.
  215.  
  216.         assign MyDisk: SYS:
  217.         run MyFontEditor
  218.  
  219.  
  220.  
  221. I realize this documentation is brief but I made MenuWriter to be as
  222. intuitively as possible.
  223.  
  224.  
  225. Future enhancements
  226. -------------------
  227.  
  228. - An option to customize the colors of the menu.
  229. - More security checks
  230. - Custom password
  231.  
  232. © 1990 Peter Stuer
  233.                          _
  234.                       _ //
  235.             Thanks to \X/ Amiga for being the best computer ever !
  236.             Thanks to BSB for beta testing and giving useful comments.
  237.